Skip to content

Fix remaining errors in ValidationErrorList Javadoc example - #922

Open
VolodymyrLinuxovich wants to merge 1 commit into
ESAPI:developfrom
VolodymyrLinuxovich:issue-788
Open

VolodymyrLinuxovich wants to merge 1 commit into
ESAPI:developfrom
VolodymyrLinuxovich:issue-788

Conversation

@VolodymyrLinuxovich

Copy link
Copy Markdown

Closes #788

PR #791 fixed part of the example in the ValidationErrorList class Javadoc, but a few problems were left. The first line still declared the variable as ValidationErrorList() errorList, which does not compile, and the two getValidInteger calls were still missing ESAPI.validator(). like the getValidInput calls above them.

While there I also fixed "The at your view layer" to "Then at your view layer", and changed Constants.ERROR_LIST in the view helper to the "ERROR_LIST" string the rest of the example uses, since there is no such constant in ESAPI.

This only touches the Javadoc comment, no code changes.

@xeno6696 xeno6696 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks straightforward enough.

I appreciate asking for more work, but given that say Kevin is an expert in crypto code and I'm more input/output encoding... I would hate to hand you something beyond your comfort zone. I'd suggest looking at the open issues and filtering on... we have a tag for first issues I just blank on what it is. #goodfirstissue maybe?

@kwwall

kwwall commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

@VolodymyrLinuxovich - Since you touched up this Javadoc, do you suppose that you can also fix the return errors; at line 52. It has an extra tab or spaces. You can see that it's messed up here: https://javadoc.io/static/org.owasp.esapi/esapi/2.7.0.0/org/owasp/esapi/ValidationErrorList.html

Also, @VolodymyrLinuxovich, you will have to do a signed commit to get this merged. (See https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits for details.) That requirement is mentioned at https://github.com/ESAPI/esapi-java-legacy/blob/develop/CONTRIBUTING.md#a-special-note-regarding-making-commits-for-prs

@jeremiahjstacey - Once that happens, could you approve this after that change? I generally don't have access to a computer at the rehab facilities where my wife is recovering, otherwise I would do it and usually by the time I get home, I'm too exhausted to open my laptop and work on ESAPI. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix Javadoc code example in ValidationErrorList

3 participants